Fix race condition in PeerConnectionTransport.trackBitrates#821
Open
adrian-niculescu wants to merge 1 commit into
Open
Fix race condition in PeerConnectionTransport.trackBitrates#821adrian-niculescu wants to merge 1 commit into
adrian-niculescu wants to merge 1 commit into
Conversation
🦋 Changeset detectedLatest commit: 7ff2a49 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
e16141d to
7ff2a49
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
PeerConnectionTransport.trackBitratesis a plainmutableMapOf<...>()(aLinkedHashMap) with no thread-safety. Reads and writes on it race inside a singleLocalParticipant.negotiate()call.engine.createSenderTransceiver(...)causes WebRTC to fireonRenegotiationNeeded. That goes throughPublisherTransportObserver.onRenegotiationNeeded()andengine.negotiatePublisher()into the 20ms-debouncednegotiatefield. When the debounce closes,createAndSendOfferiterates the map on the RTC thread viaensureCodecBitrates(...).Still inside the same
negotiate()body,engine.registerTrackBitrateInfo(...)writes to the map on the calling coroutine's thread. The auto-trigger is intentional and documented inLocalParticipant: "PublisherTransportObserver.onRenegotiationNeeded()gets triggered automatically so no need to call negotiate manually."If the debounce closes while a put is still in flight, iteration on the RTC thread can throw
ConcurrentModificationExceptionfromensureCodecBitrates. Any publish path that hits thiscreateSenderTransceiverthenregisterTrackBitrateInfosequence is exposed (SVC video with amaxBitrateBpsencoding).Fix
Route both
registerTrackBitrateInfooverloads throughexecuteRTCIfNotClosed { ... }so writes share the single-threaded RTC executor with the read site. Same pattern asupdateRTCConfigandaddIceCandidatein the same class. The RTC thread already serves as the lock for peer-connection-adjacent state.The closed-state guard inside
executeRTCIfNotClosedalso makes post-close calls silently drop, matching the surrounding APIs.Scope
Independent of #823, which added a
MutexaroundcreateAndSendOfferfor concurrent offer creation. That PR did not touchregisterTrackBitrateInfo, so this race remained onmain. No API or behavioral change for callers beyond the write going through the RTC executor.